Skip to main content
POST
[Monitors] Run monitor check

Authorizations

Authorization
string
header
required

Use Authorization: Bearer <token> header. Token can be a JWT token or an API key (format: sk-onetsolutions-...).

Path Parameters

id
string<uuid>
required

A UUID string identifying this Instance.

monitor_id
string
required

Unique identifier of the monitor.

organization_id
string<uuid>
required
project_id
string<uuid>
required

Body

application/json
name
string
required

Instance hostname

Maximum string length: 255
size_id
string<uuid>
required
write-only
location_id
string<uuid>
required
write-only
image_id
string<uuid>
required
write-only
os_name
string
required

Operating system name

Maximum string length: 100
vpc_id
string<uuid> | null
write-only
billing_cycle
enum<string>
  • free - Free
  • one_time - One Time
  • hourly - Hourly
  • monthly - Monthly
  • quarterly - Quarterly
  • semi_annually - Semi-Annually
  • annually - Annually
  • biennially - Biennially
  • triennially - Triennially
Available options:
free,
one_time,
hourly,
monthly,
quarterly,
semi_annually,
annually,
biennially,
triennially
tags
string[]

Custom tags

Maximum string length: 50

Response

200 - application/json
id
string<uuid>
required
read-only
monitor
string<uuid>
required
status
enum<string>
required
  • up - Up
  • down - Down
  • degraded - Degraded
  • pending - Pending
Available options:
up,
down,
degraded,
pending
checked_at
string<date-time>
required
read-only
latency_ms
string | null
Pattern: ^-?\d{0,8}(?:\.\d{0,2})?$
response_code
string
Maximum string length: 50
error_message
string